GermanWikipedia - /page/entry.mu

Micron Document

<!DOCTYPE html>

</head>

</header>

</div>

<div id="mw-content-text" class="mw-body-content mw-content-ltr" lang="de" dir="ltr"><div class="mw-content-ltr mw-parser-output" lang="de" dir="ltr"><p><b>JSON-RPC</b> (<a href="JavaScript_Object_Notation" class="mw-redirect" title="JavaScript Object Notation">JavaScript Object Notation</a> <a href="Remote_Procedure_Call" title="Remote Procedure Call">Remote Procedure Call</a>) ist ein Protokoll zum Aufruf von <a href="Methode_(Programmierung)" title="Methode (Programmierung)">Methoden</a> in <a href="Verteiltes_System" title="Verteiltes System">entfernten Computersystemen</a>, ähnlich wie <a href="XML-RPC" title="XML-RPC">XML-RPC</a> (die Daten werden jedoch in <a href="JavaScript_Object_Notation" class="mw-redirect" title="JavaScript Object Notation">JSON</a> statt in <a href="Extensible_Markup_Language" title="Extensible Markup Language">XML</a> gesendet).

Bei der Spezifikation wurde darauf geachtet, dass JSON-RPC möglichst keine unnötige Komplexität enthält und über verschiedene <a href="Kommunikationsprotokoll" title="Kommunikationsprotokoll">Kommunikationsprotokolle</a> genutzt werden kann. Dadurch kann es sehr flexibel eingesetzt werden. Zudem unterstützt das Protokoll

<a href="Asynchrone_Kommunikation" title="Asynchrone Kommunikation">asynchrone Kommunikation</a>, da alle Anfragen und Antworten eine ID enthalten, was eine einfache Zuordnung von Antworten zu den entsprechenden Anfragen ermöglicht.

</p><p>JSON-RPC 1.0 erlaubt Anfragen in beide Richtungen (<a href="Peer-to-Peer" title="Peer-to-Peer">Peer-to-Peer</a>), die meisten JSON-RPC 1.0 Implementierungen unterstützen jedoch standardmäßig nur eine Richtung (<a href="Client-Server-Modell" title="Client-Server-Modell">Client-Server-Modell</a>).

</p><p>JSON-RPC 2.0 verwendet ein <a href="Client-Server-Modell" title="Client-Server-Modell">Client-Server-Modell</a>. Anfragen in beide Richtungen sind möglich, indem auf beiden Seiten ein JSON-RPC-Server verwendet wird.

</p>

<div class="mw-heading mw-heading2"><h2 id="Funktionsweise">Funktionsweise</h2></div>

<div class="mw-heading mw-heading3"><h3 id="Anfrage">Anfrage</h3></div>

<p>Ein JSON-RPC-Call besteht aus einem <a href="JavaScript_Object_Notation#Datenstruktur_und_Formatdefinition" class="mw-redirect" title="JavaScript Object Notation">JSON-Objekt</a>, das vom <a href="Client" title="Client">Client</a> an einen <a href="Server" title="Server">Server</a> geschickt wird. Mögliche Anfragetypen sind

</p>

<ul><li>Request (englisch für: „Anfrage“): Der Server soll eine Antwort liefern.</li>

<li>Notification (englisch für: „Benachrichtigung“): Einwegkommunikation, vom Server wird keine Antwort erwartet.</li>

<li>Batch Request (englisch für: „Stapelanfrage“): Mehrere Anfragen (<i>Notifications</i> oder <i>Requests</i>) werden zusammengefasst als JSON-Array gesendet, dessen Elemente dann die einzelnen Request-Objekte sind. (Verfügbar ab Version 2.0)</li></ul>

<p>In der folgenden Tabelle sind die Bestandteile eines Request-Objekts aufgelistet.

</p>

<th>Bestandteil

</th>

<th>Beschreibung

</th>

<th>Bemerkung

</th></tr>

<tr>

<td><code>jsonrpc</code>

</td>

<td>Ein String mit dem Namen der JSON-RPC-Version ("2.0")

</td>

<td>Ab Version 2.0

</td></tr>

<tr>

<td><code>method</code>

</td>

<td>Ein String mit dem Namen der Funktion, die aufgerufen werden soll.

</td>

<td>

</td></tr>

<tr>

<td><code>params</code>

</td>

<td>Ein Array oder Objekt mit den Parametern, die der Funktion übergeben werden sollen.

</td>

<td>Objekt ab Version 2.0 möglich

</td></tr>

<tr>

</td>

<td>Ein eindeutiger Identifikator für die Nachricht. Kann jeden beliebigen <a href="Datentyp" title="Datentyp">Datentyp</a> haben (i. d. R. Integer).

</td>

<td>

</td></tr></tbody></table>

<p>Eine Notification zeichnet sich dadurch aus, dass:

</p>

<ul><li>JSON-RPC Version 2.0: <code>id</code> fehlt</li>

<li>JSON-RPC Version 1.0: <code>id</code> <code>null</code> ist</li></ul>

<div class="mw-heading mw-heading3"><h3 id="Antwort">Antwort</h3></div>

<p>Im Fall eines Requests schickt der Server nach der Ausführung der angeforderten Methode eine Antwort als JSON-Objekt zurück an den Client. Die Bestandteile eines Response-Objektes sind in der folgenden Tabelle aufgelistet.

</p>

<th>Bestandteile

</th>

<th>Beschreibung

</th>

<th>Bemerkung

</th></tr>

<tr>

<td><code>jsonrpc</code>

</td>

<td>Ein String mit dem Namen der JSON-RPC-Version („2.0“)

</td>

<td>Ab Version 2.0

</td></tr>

<tr>

<td><code>result</code>

</td>

<td>Das Rückgabeobjekt der Funktion, falls kein RPC-Fehler auftrat. Andernfalls:

<ul><li>Version 2.0: wird dieses Feld weggelassen.</li>

<li>Version 1.0: hat dieses Feld den Wert <code>null</code>.</li></ul>

</td>

<td>

</td></tr>

<tr>

<td><code>error</code>

</td>

<td>Das Fehlerobjekt, falls ein RPC-Fehler auftrat. Andernfalls:

<ul><li>Version 2.0: wird dieses Feld weggelassen.</li>

<li>Version 1.0: hat dieses Feld den Wert <code>null</code>.</li></ul>

</td>

<td>

</td></tr>

<tr>

</td>

<td>Enthält den gleichen Wert wie <code>id</code> des Requests, der diese Response verursacht hat.

</td>

<td>

</td></tr></tbody></table>

<p>Erhält der Server eine Notification, führt er die angegebene Methode aus, sendet jedoch keine Antwort.

Erhält er einen Batch-Request, führt er die aufgelisteten Methoden aus, und sendet eine Batch-Response (d. h. die Antworten auf alle Requests im Batch-Request in einer Nachricht).

</p>

<div class="mw-heading mw-heading2"><h2 id="Beispiele">Beispiele</h2></div>

<p>In diesen Beispielen steht <code>--></code> für eine Nachricht vom Client an der Server, und <code><--</code> umgekehrt.

</p>

<div class="mw-heading mw-heading3"><h3 id="Version_2.0">Version 2.0</h3></div>

<p>Ein einfaches Beispiel mit einer Anfrage und einer Antwort:

</p>

<code><pre>--> { "jsonrpc": "2.0", "method": "gibAus", "params": ["Hallo JSON-RPC"], "id": 1}

<-- { "jsonrpc": "2.0", "result": "Hallo JSON-RPC", "id": 1}

</pre></code>

<p>Gleiches Beispiel mit "named parameters":

</p>

<code><pre>--> { "jsonrpc": "2.0", "method": "gibAus", "params": {"Nachricht": "Hallo JSON-RPC"}, "id": 2}

<-- { "jsonrpc": "2.0", "result": "Hallo JSON-RPC", "id": 2}

</pre></code>

<p>Weitere Beispiele finden sich am Ende der JSON-RPC 2.0 Spezifikation.

</p>

<div class="mw-heading mw-heading3"><h3 id="Version_1.0">Version 1.0</h3></div>

<p>Ein einfaches Beispiel mit einer Anfrage und einer Antwort

</p>

<pre>--> { "method": "gibAus", "params": ["Hallo JSON-RPC"], "id": 1}

<-- { "result": "Hallo JSON-RPC", "error": null, "id": 1}

</pre>

<p>Dieses Beispiel zeigt einen Teil der Kommunikation in einer Chat-Anwendung. Der Chat-Dienst sendet eine <i>Notification</i> für jede Nachricht, die der Client erhalten soll. Der Client sendet einen <i>Request</i>, um eine Nachricht zu senden und erwartet eine positive Rückmeldung, um zu wissen, dass die Nachricht veröffentlicht wurde.<sup id="cite_ref-1" class="reference"><a href="#cite_note-1"><span class="cite-bracket">[</span>1<span class="cite-bracket">]</span></a></sup>

</p>

<pre>...

--> {"method": "veröffentlicheNachricht", "params": ["Hallo an alle!"], "id": 99}

<-- {"result": 1, "error": null, "id": 99}

<-- {"method": "empfangeNachricht", "params": ["Benutzer1", "Wir unterhielten uns gerade"], "id": null}

<-- {"method": "empfangeNachricht", "params": ["Benutzer3", "Ich muss jetzt los, tschüss"], "id": null}

--> {"method": "veröffentlicheNachricht", "params": ["Ich habe eine Frage!"], "id": 101}

<-- {"method": "ändereStatus", "params": ["abwesend","Benutzer3"], "id": null}

<-- {"result": 1, "error": null, "id": 101}

...

</pre>

<div class="mw-heading mw-heading2"><h2 id="Versionsgeschichte">Versionsgeschichte</h2></div>

<p>Die erste Version vom JSON-RPC stammt von 2005. Die Version 2.0 wurde 2010 verabschiedet.

</p>

<th>Version

</th>

<th>Beschreibung

</th>

<th>Datum

</th></tr>

<tr>

<td>1.0

</td>

<td>Original-Version<sup id="cite_ref-2" class="reference"><a href="#cite_note-2"><span class="cite-bracket">[</span>2<span class="cite-bracket">]</span></a></sup>

</td>

<td>2005

</td></tr>

<tr>

<td>Entwurf „1.1 WD“

</td>

<td>Auf HTTP eingeschränkt, benannte Parameter, spezifische Fehlercodes und introspektive Funktionen hinzugefügt.

</td>

<td>07.08.2006

</td></tr>

<tr>

<td>Entwurf „1.1 Alt“

</td>

<td>Alternativer (vereinfachter) Vorschlag für 1.1 WD.

</td>

<td>06.05.2007

</td></tr>

<tr>

<td>Entwurf „1.2“

</td>

<td>Leicht modifizierte Variante von 1.1 Alt. Eine spätere Version wurde in 2.0 umbenannt.

</td>

<td>27.12.2007

</td></tr>

<tr>

<td>2.0

</td>

<td>aktuelle Spezifikation<sup id="cite_ref-3" class="reference"><a href="#cite_note-3"><span class="cite-bracket">[</span>3<span class="cite-bracket">]</span></a></sup>

</td>

<td>2010

</td></tr></tbody></table>

<div class="mw-heading mw-heading2"><h2 id="Implementierungen">Implementierungen</h2></div>

<p>JSON-RPC wurde in verschiedenen Programmiersprachen implementiert, darunter <a href="JavaScript" title="JavaScript">JavaScript</a>, <a href="C%2B%2B" title="C++">C++</a>, <a href="C_(Programmiersprache)" title="C (Programmiersprache)">C</a>, <a href="C-Sharp" title="C-Sharp">C#</a>, <a href="Java_(Programmiersprache)" title="Java (Programmiersprache)">Java</a>, <a href="Python_(Programmiersprache)" title="Python (Programmiersprache)">Python</a> und <a href="PHP" title="PHP">PHP</a>. Da JSON aus Unicode-Zeichen besteht, kann JSON-RPC jedoch auch in anderen Programmiersprachen relativ einfach implementiert werden.<sup id="cite_ref-4" class="reference"><a href="#cite_note-4"><span class="cite-bracket">[</span>4<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Verbreitung">Verbreitung</h2></div>

<p>Wo überall JSON-RPC eingesetzt wird, ist in der Öffentlichkeit selten ein Thema. Google hat am 31. Juli 2019 verkündet, dass ab dem 12. August 2020 für den Zugriff auf die Google-APIs statt JSON-RPC nur noch <a href="Representational_State_Transfer" title="Representational State Transfer">REST</a> verwendet werden kann.<sup id="cite_ref-5" class="reference"><a href="#cite_note-5"><span class="cite-bracket">[</span>5<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Weblinks">Weblinks</h2></div>

<ul><li><a rel="nofollow" class="external text" href="http://jsonrpc.org/">Die offizielle JSON-RPC Website</a></li>

<li><a rel="nofollow" class="external text" href="https://groups.google.com/group/json-rpc">JSON-RPC-Google Group</a> diskutiert Themen rund um JSON-RPC.</li>

<li><a rel="nofollow" class="external text" href="http://www.simple-is-better.org/json-rpc/">JSON-RPC Spezifikationen, Links usw.</a> simple-is-better.org</li>

<li><a rel="nofollow" class="external text" href="http://json-rpc.org/">Die offizielle JSON-RPC 1.0 Website</a> enthält unter anderem eine Liste der verfügbaren JSON-RPC 1.0 Implementierungen (veraltet).</li></ul>

<div class="mw-heading mw-heading2"><h2 id="Einzelnachweise">Einzelnachweise</h2></div>

/* start https://de.wikipedia.org/ */

.mw-parser-output .webarchiv-memento a{color:inherit}

/* end https://de.wikipedia.org/ */

</style><a rel="nofollow" class="external text" href="https://web.archive.org/web/20080517011921/http://json-rpc.org/wiki/specification">specification – JSON-RPC – Trac.</a> (<span class="webarchiv-memento"><a href="Webarchivierung#Begrifflichkeiten" title="Webarchivierung">Memento</a></span> des <style data-mw-deduplicate="TemplateStyles:r250917974">

/* start https://de.wikipedia.org/ */

.mw-parser-output .dewiki-iconexternal>a{background-position:center right!important;background-repeat:no-repeat!important}body.skin-minerva .mw-parser-output .dewiki-iconexternal>a{background-image:url("./_mw_/OOjs_UI_icon_external-link-ltr-progressive.svg")!important;background-size:10px!important;padding-right:13px!important}body.skin-timeless .mw-parser-output .dewiki-iconexternal>a,body.skin-monobook .mw-parser-output .dewiki-iconexternal>a{background-image:url("./_mw_/MediaWiki_external_link_icon.svg")!important;padding-right:13px!important}body.skin-vector .mw-parser-output .dewiki-iconexternal>a{background-image:url("./_mw_/Link.ernal-small-ltr-progressive.svg")!important;background-size:0.857em!important;padding-right:1em!important}

/* end https://de.wikipedia.org/ */

</style><span class="dewiki-iconexternal"><a class="external text" href="https://redirecter.toolforge.org/?url=http%3A%2F%2Fjson-rpc.org%2Fwiki%2Fspecification">Originals</a></span> vom 17. Mai 2008 im <i><a href="Internet_Archive" title="Internet Archive">Internet Archive</a></i>) <small class="archiv-bot"><span class="wp_boppel noviewer" aria-hidden="true" role="presentation"><span typeof="mw:File"><span title="i"></span></span></span> <b>Info:</b> Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.</small><span style="display:none"><a rel="nofollow" class="external text" href="http://IABotmemento.invalid/http://json-rpc.org/wiki/specification">@1</a></span><span style="display:none"><a rel="nofollow" class="external text" href="http://json-rpc.org/wiki/specification">@2</a></span><span style="display:none">Vorlage:Webachiv/IABot/json-rpc.org</span> json-rpc.org</span>

</li>

<li id="cite_note-2"><span class="mw-cite-backlink"><a href="#cite_ref-2">↑</a></span> <span class="reference-text"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20080517011921/http://json-rpc.org/wiki/specification">json-rpc.org</a> (<span class="webarchiv-memento"><a href="Webarchivierung#Begrifflichkeiten" title="Webarchivierung">Memento</a></span> des <span class="dewiki-iconexternal"><a class="external text" href="https://redirecter.toolforge.org/?url=http%3A%2F%2Fjson-rpc.org%2Fwiki%2Fspecification">Originals</a></span> vom 17. Mai 2008 im <i><a href="Internet_Archive" title="Internet Archive">Internet Archive</a></i>) <small class="archiv-bot"><span class="wp_boppel noviewer" aria-hidden="true" role="presentation"><span typeof="mw:File"><span title="i"></span></span></span> <b>Info:</b> Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.</small><span style="display:none"><a rel="nofollow" class="external text" href="http://IABotmemento.invalid/http://json-rpc.org/wiki/specification">@1</a></span><span style="display:none"><a rel="nofollow" class="external text" href="http://json-rpc.org/wiki/specification">@2</a></span><span style="display:none">Vorlage:Webachiv/IABot/json-rpc.org</span></span>

</li>

<li id="cite_note-3"><span class="mw-cite-backlink"><a href="#cite_ref-3">↑</a></span> <span class="reference-text"><a rel="nofollow" class="external text" href="http://www.simple-is-better.org/json-rpc/jsonrpc20.html">simple-is-better.org</a></span>

</li>

<li id="cite_note-4"><span class="mw-cite-backlink"><a href="#cite_ref-4">↑</a></span> <span class="reference-text"><i><a href="Request_for_Comments" title="Request for Comments">RFC</a>: <span class="dewiki-iconexternal"><a href="https://datatracker.ietf.org/doc/html/rfc4627" class="extiw external" title="rfc:4627">4627</a></span></i> – <i><span lang="en">application/json</span></i>. (englisch).</span>

</li>

<li id="cite_note-5"><span class="mw-cite-backlink"><a href="#cite_ref-5">↑</a></span> <span class="reference-text"><span class="cite">Rainald Menge-Sonnentag: <a rel="nofollow" class="external text" href="https://www.heise.de/developer/meldung/Google-schickt-JSON-RPC-Zugriff-in-Rente-4487087.html"><i>Google schickt JSON-RPC-Zugriff in Rente.</i></a> In: <i>heise online.</i> 2. August 2019,<span class="Abrufdatum"> abgerufen am 4. August 2019</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AJSON-RPC&rft.title=Google+schickt+JSON-RPC-Zugriff+in+Rente&rft.description=Google+schickt+JSON-RPC-Zugriff+in+Rente&rft.identifier=https%3A%2F%2Fwww.heise.de%2Fdeveloper%2Fmeldung%2FGoogle-schickt-JSON-RPC-Zugriff-in-Rente-4487087.html&rft.creator=Rainald+Menge-Sonnentag&rft.date=2019-08-02"> </span></span>

</li>

</ol></div><div><div class="zim-footer">

Dieser Artikel wurde von <a class="external text" title="Zuletzt bearbeitet am 2023-10-05" href="https://de.wikipedia.org/wiki/?title=JSON-RPC&oldid=237912169">Wikipedia</a> herausgegeben. Der Text ist unter <a class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.de">Creative Commons Attribution-Share Alike 4.0</a> verfügbar, sofern nicht anders angegeben. Für die Mediendateien können zusätzliche Bedingungen gelten.

</div>

</div></div>

</div>

</main>

</div>

</body></html>